pod Doku

Hallo,

ich muss zu einigen, im Haus geschriebenen Perl-Modulen, die ich teilweise
auch noch überarbeitet habe, Dokumentation schreiben bzw. ergänzen. Ich
möchte das sinnvollerweise in/mit pod machen, sodass man die Doku mit
"perldoc " aufrufen kann.

Die bestehende Doku verwendet u.a. Tabellen und auch etliche Fußnoten. Beim
Schmökern in perlpod ist mir aber nichts untergekommen, mit dem man das
nachbilden könnte. pod scheint gerademal Überschriften verschiedener Ordnung
und einfache Listen zu unterstützen.

Daher meine Frage: war vielleicht schon mal jemand einer solchen Situation?
Wie kann man Tabellen und Fußnoten am Besten in pod einbetten?

Danke für alle Hinweise und schöne Grüße aus Wien,

Ferry

--
Ing. Ferry Bolhar
Municipality of Vienna, Department 14
A-1010 Vienna / AUSTRIA
E-mail: bol@adv.magwien.gv.at

Re: pod Doku

Hallo Ferri,

Am 14.08.2006 18:50 schrieb Ferry Bolhar:

> Hallo,
>
> ich muss zu einigen, im Haus geschriebenen Perl-Modulen, die ich teilweise
> auch noch überarbeitet habe, Dokumentation schreiben bzw. ergänzen. Ich
> möchte das sinnvollerweise in/mit pod machen, sodass man die Doku mit
> "perldoc " aufrufen kann.
>
> Die bestehende Doku verwendet u.a. Tabellen und auch etliche Fußnoten. Beim
> Schmökern in perlpod ist mir aber nichts untergekommen, mit dem man das
> nachbilden könnte. pod scheint gerademal Überschriften verschiedener Ordnung
> und einfache Listen zu unterstützen.
>
> Daher meine Frage: war vielleicht schon mal jemand einer solchen Situation?
> Wie kann man Tabellen und Fußnoten am Besten in pod einbetten?

Also mit Fußnoten wirst Du, glaube ich Pech haben. Bei den Tabellen kann
man etwas tricksen, denke ich mal. Ansttatt der Rahmen hast Du dann halt
blanks. Soweit ich nun POD kenne aus meinen Modulen werden die blanks
die man eingibt auch angezeigt. Vorallem dann wenn man eine HTML Doku
erstellt unter Activestate Perl. Ich kann mir auch vorstellen dass man
für den Rahmen | und _ und - verwenden kann. Sieht zwar nicht so schön
aus aber es sollte es aucht tun.

Grüße,
Reinhard

--
Antworten bitte nur an rpirpag at aon punkt at
Die Adresse im From/Replay to ist als Spamfänger gedacht und wird nicht
gelesen.
Please Visit: http://members.aon.at/rpagitsch/

Re: pod Doku

Reinhard Pagitsch schrieb:
> Vorallem dann wenn man eine HTML Doku erstellt [..]

Da kann man dann auch noch (zusätzlich) die Tabellen in (z.B.) HTML
schreiben. Aus `perldoc perlpod`:

=3Dbegin html


Figure 1.



=3Dend html

=3Dbegin text

---------------
| foo |
| bar |
---------------

^^^^ Figure 1. ^^^^

=3Dend text

Some format names that formatters currently are known to accept include
"roff", "man", "latex", "tex", "text", and "html". (Some for-
matters will treat some of these as synonyms.)

-Thomas

Re: pod Doku

Reinhard Pagitsch:

> Vorallem dann wenn man eine HTML Doku erstellt [..]

Das tue ich aber nicht. Es soll ganz normales POD werden,
das man sich mit "perldoc " von jedem
Terminalfenster aus ansehen kann.

Thomas Wittek:

>Da kann man dann auch noch (zusätzlich) die Tabellen in (z.B.) HTML
> schreiben. Aus `perldoc perlpod`:

[...]

Bringt mir das hier etwas? Wird HTML dann automatisch zu ASCI
konvertiert?

LG, Ferry

--
Ing. Ferry Bolhar
Municipality of Vienna, Department 14
A-1010 Vienna / AUSTRIA
E-mail: bol@adv.magwien.gv.at

Re: pod Doku

Ferry Bolhar schrieb:
> Reinhard Pagitsch:
>
>> Vorallem dann wenn man eine HTML Doku erstellt [..]
>
> Das tue ich aber nicht.

Dann gilt wohl: Wer Text haben will, muss Text schreiben (und Tabellen
etc. in ASCII bauen oder evtl. mit Hilfe von Text::Table) ;)

> Bringt mir das hier etwas? Wird HTML dann automatisch zu ASCI
> konvertiert?

Nein, die Text-Formatierer ignorieren HTML-Abschnitte.

-Thomas